[−][src]Crate zstd_sys
Structs
| ZSTD_CCtx_s | |
| ZSTD_CDict_s | |
| ZSTD_DCtx_s | |
| ZSTD_DDict_s | |
| ZSTD_bounds | |
| ZSTD_inBuffer_s | Streaming |
| ZSTD_outBuffer_s |
Enums
| ZSTD_EndDirective | |
| ZSTD_ResetDirective | |
| ZSTD_cParameter | |
| ZSTD_dParameter | Advanced decompression API |
| ZSTD_strategy | Advanced compression API |
Constants
Functions
| ZDICT_getDictID⚠ | |
| ZDICT_getErrorName⚠ | |
| ZDICT_isError⚠ | |
| ZDICT_trainFromBuffer⚠ | ZDICT_trainFromBuffer():
Train a dictionary from an array of samples.
Redirect towards ZDICT_optimizeTrainFromBuffer_fastCover() single-threaded, with d=8, steps=4,
f=20, and accel=1.
Samples must be stored concatenated in a single flat buffer |
| ZSTD_CCtx_loadDictionary⚠ | ZSTD_CCtx_loadDictionary() :
Create an internal CDict from |
| ZSTD_CCtx_refCDict⚠ | ZSTD_CCtx_refCDict() : Reference a prepared dictionary, to be used for all next compressed frames. Note that compression parameters are enforced from within CDict, and supersede any compression parameter previously set within CCtx. The parameters ignored are labled as "superseded-by-cdict" in the ZSTD_cParameter enum docs. The ignored parameters will be used again if the CCtx is returned to no-dictionary mode. The dictionary will remain valid for future compressed frames using same CCtx. @result : 0, or an error code (which can be tested with ZSTD_isError()). Special : Referencing a NULL CDict means "return to no-dictionary mode". Note 1 : Currently, only one dictionary can be managed. Referencing a new dictionary effectively "discards" any previous one. Note 2 : CDict is just referenced, its lifetime must outlive its usage within CCtx. |
| ZSTD_CCtx_refPrefix⚠ | ZSTD_CCtx_refPrefix() : Reference a prefix (single-usage dictionary) for next compressed frame. A prefix is only used once. Tables are discarded at end of frame (ZSTD_e_end). Decompression will need same prefix to properly regenerate data. Compressing with a prefix is similar in outcome as performing a diff and compressing it, but performs much faster, especially during decompression (compression speed is tunable with compression level). @result : 0, or an error code (which can be tested with ZSTD_isError()). Special: Adding any prefix (including NULL) invalidates any previous prefix or dictionary Note 1 : Prefix buffer is referenced. It must outlive compression. Its content must remain unmodified during compression. Note 2 : If the intention is to diff some large src data blob with some prior version of itself, ensure that the window size is large enough to contain the entire source. See ZSTD_c_windowLog. Note 3 : Referencing a prefix involves building tables, which are dependent on compression parameters. It's a CPU consuming operation, with non-negligible impact on latency. If there is a need to use the same prefix multiple times, consider loadDictionary instead. Note 4 : By default, the prefix is interpreted as raw content (ZSTD_dm_rawContent). Use experimental ZSTD_CCtx_refPrefix_advanced() to alter dictionary interpretation. |
| ZSTD_CCtx_reset⚠ | ZSTD_CCtx_reset() : There are 2 different things that can be reset, independently or jointly : |
| ZSTD_CCtx_setParameter⚠ | ZSTD_CCtx_setParameter() : Set one compression parameter, selected by enum ZSTD_cParameter. All parameters have valid bounds. Bounds can be queried using ZSTD_cParam_getBounds(). Providing a value beyond bound will either clamp it, or trigger an error (depending on parameter). Setting a parameter is generally only possible during frame initialization (before starting compression). Exception : when using multi-threading mode (nbWorkers >= 1), the following parameters can be updated during compression (within same frame): => compressionLevel, hashLog, chainLog, searchLog, minMatch, targetLength and strategy. new parameters will be active for next job only (after a flush()). @return : an error code (which can be tested using ZSTD_isError()). |
| ZSTD_CCtx_setPledgedSrcSize⚠ | ZSTD_CCtx_setPledgedSrcSize() : Total input data size to be compressed as a single frame. Value will be written in frame header, unless if explicitly forbidden using ZSTD_c_contentSizeFlag. This value will also be controlled at end of frame, and trigger an error if not respected. @result : 0, or an error code (which can be tested with ZSTD_isError()). Note 1 : pledgedSrcSize==0 actually means zero, aka an empty frame. In order to mean "unknown content size", pass constant ZSTD_CONTENTSIZE_UNKNOWN. ZSTD_CONTENTSIZE_UNKNOWN is default value for any new frame. Note 2 : pledgedSrcSize is only valid once, for the next frame. It's discarded at the end of the frame, and replaced by ZSTD_CONTENTSIZE_UNKNOWN. Note 3 : Whenever all input data is provided and consumed in a single round, for example with ZSTD_compress2(), or invoking immediately ZSTD_compressStream2(,,,ZSTD_e_end), this value is automatically overridden by srcSize instead. |
| ZSTD_CStreamInSize⚠ | |
| ZSTD_CStreamOutSize⚠ | |
| ZSTD_DCtx_loadDictionary⚠ | ZSTD_DCtx_loadDictionary() :
Create an internal DDict from dict buffer,
to be used to decompress next frames.
The dictionary remains valid for all future frames, until explicitly invalidated.
@result : 0, or an error code (which can be tested with ZSTD_isError()).
Special : Adding a NULL (or 0-size) dictionary invalidates any previous dictionary,
meaning "return to no-dictionary mode".
Note 1 : Loading a dictionary involves building tables,
which has a non-negligible impact on CPU usage and latency.
It's recommended to "load once, use many times", to amortize the cost
Note 2 : |
| ZSTD_DCtx_refDDict⚠ | ZSTD_DCtx_refDDict() : Reference a prepared dictionary, to be used to decompress next frames. The dictionary remains active for decompression of future frames using same DCtx. @result : 0, or an error code (which can be tested with ZSTD_isError()). Note 1 : Currently, only one dictionary can be managed. Referencing a new dictionary effectively "discards" any previous one. Special: referencing a NULL DDict means "return to no-dictionary mode". Note 2 : DDict is just referenced, its lifetime must outlive its usage from DCtx. |
| ZSTD_DCtx_refPrefix⚠ | ZSTD_DCtx_refPrefix() : Reference a prefix (single-usage dictionary) to decompress next frame. This is the reverse operation of ZSTD_CCtx_refPrefix(), and must use the same prefix as the one used during compression. Prefix is only used once. Reference is discarded at end of frame. End of frame is reached when ZSTD_decompressStream() returns 0. @result : 0, or an error code (which can be tested with ZSTD_isError()). Note 1 : Adding any prefix (including NULL) invalidates any previously set prefix or dictionary Note 2 : Prefix buffer is referenced. It must outlive decompression. Prefix buffer must remain unmodified up to the end of frame, reached when ZSTD_decompressStream() returns 0. Note 3 : By default, the prefix is treated as raw content (ZSTD_dm_rawContent). Use ZSTD_CCtx_refPrefix_advanced() to alter dictMode (Experimental section) Note 4 : Referencing a raw content prefix has almost no cpu nor memory cost. A full dictionary is more costly, as it requires building tables. |
| ZSTD_DCtx_reset⚠ | ZSTD_DCtx_reset() : Return a DCtx to clean state. Session and parameters can be reset jointly or separately. Parameters can only be reset when no active frame is being decompressed. @return : 0, or an error code, which can be tested with ZSTD_isError() |
| ZSTD_DCtx_setParameter⚠ | ZSTD_DCtx_setParameter() : Set one compression parameter, selected by enum ZSTD_dParameter. All parameters have valid bounds. Bounds can be queried using ZSTD_dParam_getBounds(). Providing a value beyond bound will either clamp it, or trigger an error (depending on parameter). Setting a parameter is only possible during frame initialization (before starting decompression). @return : 0, or an error code (which can be tested using ZSTD_isError()). |
| ZSTD_DStreamInSize⚠ | |
| ZSTD_DStreamOutSize⚠ | |
| ZSTD_cParam_getBounds⚠ | ZSTD_cParam_getBounds() : All parameters must belong to an interval with lower and upper bounds, otherwise they will either trigger an error or be automatically clamped. @return : a structure, ZSTD_bounds, which contains - an error status field, which must be tested using ZSTD_isError() - lower and upper bounds, both inclusive |
| ZSTD_compress⚠ | Simple API
Compresses |
| ZSTD_compress2⚠ | ZSTD_compress2() : Behave the same as ZSTD_compressCCtx(), but compression parameters are set using the advanced API. ZSTD_compress2() always starts a new frame. Should cctx hold data from a previously unfinished frame, everything about it is forgotten. |
| ZSTD_compressBound⚠ | |
| ZSTD_compressCCtx⚠ | ZSTD_compressCCtx() : Same as ZSTD_compress(), using an explicit ZSTD_CCtx The function will compress at requested compression level, ignoring any other parameter |
| ZSTD_compressStream⚠ | Alternative for ZSTD_compressStream2(zcs, output, input, ZSTD_e_continue). NOTE: The return value is different. ZSTD_compressStream() returns a hint for the next read size (if non-zero and not an error). ZSTD_compressStream2() returns the minimum nb of bytes left to flush (if non-zero and not an error). |
| ZSTD_compressStream2⚠ | ZSTD_compressStream2() : Behaves about the same as ZSTD_compressStream, with additional control on end directive. |
| ZSTD_compress_usingCDict⚠ | ZSTD_compress_usingCDict() : Compression using a digested Dictionary. Recommended when same dictionary is used multiple times. Note : compression level is decided at dictionary creation time, and frame parameters are hardcoded (dictID=yes, contentSize=yes, checksum=no) |
| ZSTD_compress_usingDict⚠ | Simple dictionary API
Compression at an explicit compression level using a Dictionary.
A dictionary can be any arbitrary data segment (also called a prefix),
or a buffer with specified information (see dictBuilder/zdict.h).
Note : This function loads the dictionary, resulting in significant startup delay.
It's intended for a dictionary used only once.
Note 2 : When |
| ZSTD_createCCtx⚠ | |
| ZSTD_createCDict⚠ | ZSTD_createCDict() :
When compressing multiple messages / blocks using the same dictionary, it's recommended to load it only once.
ZSTD_createCDict() will create a digested dictionary, ready to start future compression operations without startup cost.
ZSTD_CDict can be created once and shared by multiple threads concurrently, since its usage is read-only.
|
| ZSTD_createCStream⚠ | |
| ZSTD_createDCtx⚠ | |
| ZSTD_createDDict⚠ | ZSTD_createDDict() : Create a digested dictionary, ready to start decompression operation without startup delay. dictBuffer can be released after DDict creation, as its content is copied inside DDict. |
| ZSTD_createDStream⚠ | |
| ZSTD_dParam_getBounds⚠ | ZSTD_dParam_getBounds() : All parameters must belong to an interval with lower and upper bounds, otherwise they will either trigger an error or be automatically clamped. @return : a structure, ZSTD_bounds, which contains - an error status field, which must be tested using ZSTD_isError() - both lower and upper bounds, inclusive |
| ZSTD_decompress⚠ | ZSTD_decompress() :
|
| ZSTD_decompressDCtx⚠ | ZSTD_decompressDCtx() : Same as ZSTD_decompress(), requires an allocated ZSTD_DCtx. Compatible with sticky parameters. |
| ZSTD_decompressStream⚠ | |
| ZSTD_decompress_usingDDict⚠ | ZSTD_decompress_usingDDict() : Decompression using a digested Dictionary. Recommended when same dictionary is used multiple times. |
| ZSTD_decompress_usingDict⚠ | ZSTD_decompress_usingDict() :
Decompression using a known Dictionary.
Dictionary must be identical to the one used during compression.
Note : This function loads the dictionary, resulting in significant startup delay.
It's intended for a dictionary used only once.
Note : When |
| ZSTD_endStream⚠ | Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_end). |
| ZSTD_findFrameCompressedSize⚠ | ZSTD_findFrameCompressedSize() :
|
| ZSTD_flushStream⚠ | Equivalent to ZSTD_compressStream2(zcs, output, &emptyInput, ZSTD_e_flush). |
| ZSTD_freeCCtx⚠ | |
| ZSTD_freeCDict⚠ | ZSTD_freeCDict() : Function frees memory allocated by ZSTD_createCDict(). |
| ZSTD_freeCStream⚠ | |
| ZSTD_freeDCtx⚠ | |
| ZSTD_freeDDict⚠ | ZSTD_freeDDict() : Function frees memory allocated with ZSTD_createDDict() |
| ZSTD_freeDStream⚠ | |
| ZSTD_getDecompressedSize⚠ | ZSTD_getDecompressedSize() :
NOTE: This function is now obsolete, in favor of ZSTD_getFrameContentSize().
Both functions work the same way, but ZSTD_getDecompressedSize() blends
"empty", "unknown" and "error" results to the same return value (0),
while ZSTD_getFrameContentSize() gives them separate return values.
@return : decompressed size of |
| ZSTD_getDictID_fromDDict⚠ | ZSTD_getDictID_fromDDict() :
Provides the dictID of the dictionary loaded into |
| ZSTD_getDictID_fromDict⚠ | ZSTD_getDictID_fromDict() : Provides the dictID stored within dictionary. if @return == 0, the dictionary is not conformant with Zstandard specification. It can still be loaded, but as a content-only dictionary. |
| ZSTD_getDictID_fromFrame⚠ | ZSTD_getDictID_fromFrame() :
Provides the dictID required to decompressed the frame stored within |
| ZSTD_getErrorName⚠ | |
| ZSTD_getFrameContentSize⚠ | |
| ZSTD_initCStream⚠ | Equivalent to: |
| ZSTD_initDStream⚠ | |
| ZSTD_isError⚠ | |
| ZSTD_maxCLevel⚠ | |
| ZSTD_minCLevel⚠ | |
| ZSTD_sizeof_CCtx⚠ | ZSTD_sizeof_*() : These functions give the current memory usage of selected object. Note that object memory usage can evolve (increase or decrease) over time. |
| ZSTD_sizeof_CDict⚠ | |
| ZSTD_sizeof_CStream⚠ | |
| ZSTD_sizeof_DCtx⚠ | |
| ZSTD_sizeof_DDict⚠ | |
| ZSTD_sizeof_DStream⚠ | |
| ZSTD_versionNumber⚠ | |
| ZSTD_versionString⚠ |
Type Definitions
| ZSTD_CCtx | Explicit context |
| ZSTD_CDict | Bulk processing dictionary API |
| ZSTD_CStream | |
| ZSTD_DCtx | |
| ZSTD_DDict | |
| ZSTD_DStream | |
| ZSTD_inBuffer | |
| ZSTD_outBuffer | |
| wchar_t |